/*
 * Copyright 2008-2009 ArtisanLogic.com.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.artisanlogic.lang;

// =====================================================================================================================
// Utils.java                                                                                    Created on Feb 21, 2009
// ---------------------------------------------------------------------------------------------------------------------
/**
 * This class is a collection of static utility functions for general tasks.
 * 
 * @author sean@artisanlogic.com
 * @since 0.9-Beta
 */
// =====================================================================================================================
public class Utils {
  
  // -------------------------------------------------------------------------------------------------------------------
  // constructors
  // -------------------------------------------------------------------------------------------------------------------

  /*
   * Private constructor to restrict usage to static methods only
   */
  private Utils() {}
  
  // -------------------------------------------------------------------------------------------------------------------
  // public static methods
  // -------------------------------------------------------------------------------------------------------------------
  
  /**
   * This method verifies the presence of required parameters.
   * 
   * @param name The name of the parameter to verify the presence of.
   * @param value The value of the required parameter.
   * @throws IllegalArgumentException This method throws and IllegalArgumentException if either the name or value 
   *  parameters are found to be null. 
   */
  public static void requireParameter(String name, Object value) throws IllegalArgumentException {
    if(name == null) {
      throw new IllegalArgumentException("The name parameter cannot be null.");
    }
    if(value == null) {
      throw new IllegalArgumentException("The " + name + " parameter cannot be null.");
    }
  }

}
